home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3n / t_rcv.z / t_rcv
Encoding:
Text File  |  2002-10-03  |  8.6 KB  |  133 lines
  1.  
  2.  
  3.  
  4. tttt____rrrrccccvvvv((((3333NNNN))))                                                            tttt____rrrrccccvvvv((((3333NNNN))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      _tttt______rrrr_cccc_vvvv - receive data or expedited data sent over a connection
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      _####_iiii_ffff_dddd_eeee_ffff ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE
  13.      _####_iiii_nnnn_cccc_llll_uuuu_dddd_eeee _<<<<_xxxx_tttt_iiii_...._hhhh_>>>>
  14.      _####_eeee_nnnn_dddd_iiii_ffff
  15.  
  16.      _iiii_nnnn_tttt _tttt______rrrr_cccc_vvvv _((((_iiii_nnnn_tttt _ffff_dddd_,,,, _cccc_hhhh_aaaa_rrrr _****_bbbb_uuuu_ffff_,,,, _uuuu_nnnn_ssss_iiii_gggg_nnnn_eeee_dddd _nnnn_bbbb_yyyy_tttt_eeee_ssss_,,,, _iiii_nnnn_tttt _****_ffff_llll_aaaa_gggg_ssss_))))_;;;;
  17.  
  18. DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.      This function receives either normal or expedited data.  _ffff_dddd identifies
  20.      the local transport endpoint through which data will arrive, _bbbb_uuuu_ffff points
  21.      to a receive buffer where user data will be placed, and _nnnn_bbbb_yyyy_tttt_eeee_ssss specifies
  22.      the size of the receive buffer.  _ffff_llll_aaaa_gggg_ssss may be set on return from _tttt______rrrr_cccc_vvvv
  23.      and specifies optional flags as described below.
  24.  
  25.      By default, _tttt______rrrr_cccc_vvvv operates in synchronous mode and will wait for data to
  26.      arrive if none is currently available.  However, if _OOOO______NNNN_DDDD_EEEE_LLLL_AAAA_YYYY or
  27.      _OOOO______NNNN_OOOO_NNNN_BBBB_LLLL_OOOO_CCCC_KKKK is set (via _tttt______oooo_pppp_eeee_nnnn or _ffff_cccc_nnnn_tttt_llll), _tttt______rrrr_cccc_vvvv will execute in
  28.      asynchronous mode and will fail if no data is available.  (See _TTTT_NNNN_OOOO_DDDD_AAAA_TTTT_AAAA
  29.      below.)
  30.  
  31.      On return from the call, if _TTTT______MMMM_OOOO_RRRR_EEEE is set in _ffff_llll_aaaa_gggg_ssss, this indicates that
  32.      there is more data and the current transport service data unit (_TTTT_SSSS_DDDD_UUUU) or
  33.      expedited transport service data unit (_EEEE_TTTT_SSSS_DDDD_UUUU) must be received in
  34.      multiple _tttt______rrrr_cccc_vvvv calls.  Each _tttt______rrrr_cccc_vvvv with the _TTTT______MMMM_OOOO_RRRR_EEEE flag set indicates that
  35.      another _tttt______rrrr_cccc_vvvv must follow to get more data for the current _TTTT_SSSS_DDDD_UUUU.  The end
  36.      of the _TTTT_SSSS_DDDD_UUUU is identified by the return of a _tttt______rrrr_cccc_vvvv call with the _TTTT______MMMM_OOOO_RRRR_EEEE
  37.      flag not set.  If the transport provider does not support the concept of
  38.      a _TTTT_SSSS_DDDD_UUUU as indicated in the _iiii_nnnn_ffff_oooo argument on return from _tttt______oooo_pppp_eeee_nnnn or
  39.      _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo, the _TTTT______MMMM_OOOO_RRRR_EEEE flag is not meaningful and should be ignored.
  40.  
  41.      On return, the data returned is expedited data if _TTTT______EEEE_XXXX_PPPP_EEEE_DDDD_IIII_TTTT_EEEE_DDDD is set in
  42.      _ffff_llll_aaaa_gggg_ssss.  If the number of bytes of expedited data exceeds _nnnn_bbbb_yyyy_tttt_eeee_ssss, _tttt______rrrr_cccc_vvvv
  43.      will set _TTTT______EEEE_XXXX_PPPP_EEEE_DDDD_IIII_TTTT_EEEE_DDDD and _TTTT______MMMM_OOOO_RRRR_EEEE on return from the initial call.
  44.      Subsequent calls to retrieve the remaining _EEEE_TTTT_SSSS_DDDD_UUUU will have _TTTT______EEEE_XXXX_PPPP_EEEE_DDDD_IIII_TTTT_EEEE_DDDD
  45.      set on return.  The end of the _EEEE_TTTT_SSSS_DDDD_UUUU is identified by the return of a
  46.      _tttt______rrrr_cccc_vvvv call with the _TTTT______MMMM_OOOO_RRRR_EEEE flag not set.
  47.  
  48.      If expedited data arrives after part of a _TTTT_SSSS_DDDD_UUUU has been retrieved,
  49.      receipt of the remainder of the _TTTT_SSSS_DDDD_UUUU will be suspended until the _EEEE_TTTT_SSSS_DDDD_UUUU
  50.      has been processed.  Only after the full _EEEE_TTTT_SSSS_DDDD_UUUU has been retrieved (_TTTT______MMMM_OOOO_RRRR_EEEE
  51.      not set) will the remainder of the _TTTT_SSSS_DDDD_UUUU be available to the user.
  52.  
  53.      This function resides within both the X/Open compliant _llll_iiii_bbbb_xxxx_nnnn_eeee_tttt and the
  54.      SVR4 compliant _llll_iiii_bbbb_nnnn_ssss_llll Network Services libraries.  Network Services
  55.      applications which require X/Open compliance must link-load with _----_llll_xxxx_nnnn_eeee_tttt.
  56.      Network Services applications which require SVR4 compliance must link-
  57.      load with _----_llll_nnnn_ssss_llll.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. tttt____rrrrccccvvvv((((3333NNNN))))                                                            tttt____rrrrccccvvvv((((3333NNNN))))
  71.  
  72.  
  73.  
  74.      On failure, _tttt______eeee_rrrr_rrrr_nnnn_oooo may be set to one of the following:
  75.  
  76.      _TTTT_BBBB_AAAA_DDDD_FFFF              The specified file descriptor does not refer to a
  77.                         transport endpoint.
  78.  
  79.      _TTTT_NNNN_OOOO_DDDD_AAAA_TTTT_AAAA            _OOOO______NNNN_DDDD_EEEE_LLLL_AAAA_YYYY or _OOOO______NNNN_OOOO_NNNN_BBBB_LLLL_OOOO_CCCC_KKKK was set, but no data is
  80.                         currently available from the transport provider.
  81.  
  82.      _TTTT_LLLL_OOOO_OOOO_KKKK              An asynchronous event has occurred on this transport
  83.                         endpoint and requires immediate attention.
  84.  
  85.      _TTTT_NNNN_OOOO_TTTT_SSSS_UUUU_PPPP_PPPP_OOOO_RRRR_TTTT        This function is not supported by the underlying
  86.                         transport provider.
  87.  
  88.      _TTTT_OOOO_UUUU_TTTT_SSSS_TTTT_AAAA_TTTT_EEEE          If ______XXXX_OOOO_PPPP_EEEE_NNNN______SSSS_OOOO_UUUU_RRRR_CCCC_EEEE is defined, then this error will be
  89.                         returned within _tttt______eeee_rrrr_rrrr_nnnn_oooo when _tttt______rrrr_cccc_vvvv() was issued in the
  90.                         wrong sequence on the transport endpoint referenced by
  91.                         _ffff_dddd.
  92.  
  93.      _TTTT_SSSS_YYYY_SSSS_EEEE_RRRR_RRRR            A system error has occurred during execution of this
  94.                         function.
  95.  
  96. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  97.      _ffff_cccc_nnnn_tttt_llll(2), _tttt______gggg_eeee_tttt_iiii_nnnn_ffff_oooo(3N), _tttt______llll_oooo_oooo_kkkk(3N), _tttt______oooo_pppp_eeee_nnnn(3N), _tttt______ssss_nnnn_dddd(3N)
  98.  
  99. DDDDIIIIAAAAGGGGNNNNOOOOSSSSTTTTIIIICCCCSSSS
  100.      On successful completion, _tttt______rrrr_cccc_vvvv returns the number of bytes received, and
  101.      it returns -1 on failure and _tttt______eeee_rrrr_rrrr_nnnn_oooo is set to indicate the error.
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.